Connectors Reference

}exghts gen. Document & more

}exghts helps you automatically generate documents. Just scan an accepted ID Card or other document and the relevant information will be extracted and automatically inserted into your new document based on a previously configured template. More actions will come soon.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

ExtractInformation ([internal]string Content-Type, [Optional]ExtractInformationParameterBody body)

Extract document information

GenerateDocument ([internal]string Content-Type, [Optional]GenerateDocumentParameterBody body)

Generate document

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ExtractInformationParameterBody

 

ExtractInformationResponse

 

GenerateDocumentParameterBody

 

 

Actions:

ExtractInformation

Summary: Extract document information

Description: Extract information from an ID Card or other documents

 

Syntax:

}exghtsgen.Document&more.ExtractInformation ([internal]string Content-Type, [Optional]ExtractInformationParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

ExtractInformationParameterBody

 

 

False

 

Returns:

          Type:ExtractInformationResponse

 

GenerateDocument

Summary: Generate document

Description: Generate the document based on the object sent as JSON

 

Syntax:

}exghtsgen.Document&more.GenerateDocument ([internal]string Content-Type, [Optional]GenerateDocumentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

GenerateDocumentParameterBody

 

 

False

 

Returns:

          Type:string(binary)Document content

Title: Document content

          Description: Contains the document content in binary format

 


 

ExtractInformationParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

Image Content Type

string

 

Image Content Type

Image File Content

string(byte)

Image File Content

Image file content in base64


 

ExtractInformationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Summary

string

 

Contains a summary of the information identified in the document (usually a person's name)

Object

string

 

Contains a JSON object containing all the extracted information

ErrorDescription

string

 

In case there is an error it contains its description or null if the ID Card was read successfully

IsSuccess

boolean

 

Contains the status of the request


 

GenerateDocumentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentInformation

string

Document Information

Document information in JSON format

templateFile

string(byte)

Document Template Content

The template file content (in base64)